home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / sbin / aspell-autobuildhash < prev    next >
Text File  |  2008-06-04  |  9KB  |  292 lines
  1. #!/usr/bin/perl -w
  2. # $Id: aspell-autobuildhash,v 1.13 2008-05-20 13:00:40 agmartin Exp $
  3. #
  4. #  script for aspell hash autorebuild in Debian systems
  5. #
  6. # Copyright 2004-2008 Agustin Martin Domingo <agmartin@debian.org>
  7. #
  8. #
  9. # This program is free software; you can redistribute it and/or modify
  10. # it under the terms of the GNU General Public License as published by
  11. # the Free Software Foundation; either version 2 of the License, or
  12. # (at your option) any later version.
  13. #
  14. # This program is distributed in the hope that it will be useful,
  15. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17. # GNU General Public License for more details.
  18. #
  19. # You should have received a copy of the GNU General Public License
  20. # along with this program; if not, write to the Free Software
  21. # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22. #
  23.  
  24. sub usage {
  25.     print STDERR "\nUsage:\taspell-autobuildhash [--debug] [--force]\n"
  26.     . "\n"
  27.     . "Options:\n"
  28.     . "\t--debug         Show debugging infor about aspell-autobuildhash\n"
  29.     . "\t                internal work. Will also enable aspell affix validation.\n"
  30.     . "\t--force         Do the job regardless of versions comparisons.\n";
  31. }
  32.  
  33. sub debugprint {
  34.     print STDERR "@_\n" if $debug;
  35. }
  36.  
  37. sub mymessage{
  38.     my $message  = join(" ",@_);
  39.     my $question = "dictionaries-common/ispell-autobuildhash-message";
  40.     my $hashfile = '';
  41.  
  42.     if ( $lang ) {
  43.     $hashfile = "$lang";
  44.     } else {
  45.     $hashfile = "dictionaries-common";
  46.     }
  47.  
  48.     subst($question,"xxpell","aspell");
  49.     subst($question,"XXpell","Aspell");
  50.     subst($question,"hashfile",$hashfile);
  51.     subst($question,"errormsg",$message);
  52.     fset ($question,"seen","false");
  53.     title("dictionaries-common: Running aspell-autobuildhash");
  54.     input("critical",$question);
  55.     go ();
  56. }
  57.  
  58. sub myerror {
  59.     mymessage @_;
  60.     exit 1;
  61. }
  62.  
  63. # ---------------------------------------------------------------------
  64. #      Handle autorebuilding
  65. # ---------------------------------------------------------------------
  66.  
  67. sub autorebuild {
  68.     my $lang      = shift ||                              # The dictionary name
  69.     myerror "No argument passed to function autorebuild";
  70.     my $data      = "/usr/lib/aspell";                    # The data/lib dir
  71.     my $langsfile = "/usr/share/aspell/$lang.contents";   # The subdicts file
  72.     my $options   = " --per-conf=/dev/null ";             # Make sure no personal conf is used at all
  73.     my @sublangs  = ();
  74.  
  75.     $options     .= " --dont-validate-affixes " unless $debug;
  76.  
  77.     myerror "aspell data dir $data does not exist" unless ( -d $data );
  78.  
  79.     if ( -e $langsfile ){
  80.     open (LANGSFILE, "< $langsfile") || die "Could not open $langsfile for reading";
  81.     @sublangs = <LANGSFILE>;
  82.     close LANGSFILE;
  83.     } else {
  84.     push @sublangs, $lang;
  85.     }
  86.  
  87.     foreach ( @sublangs ){
  88.  
  89.     next if m/^[\t\s]*$/;
  90.     chomp;
  91.     s/^[\s\t]*//;
  92.     s/[\s\t]*$//;
  93.     next if m/^\#/;
  94.  
  95.     my $sublang = $_;
  96.     my $base    = "/usr/share/aspell/$sublang";     # the wordlist basename
  97.     my $hash    = "/var/lib/aspell/$sublang.rws";   # the hash file
  98.     my $msg     = '';
  99.     my $unpack  = '';
  100.  
  101.     print STDERR "aspell-autobuildhash: processing: $lang [$sublang]\n";
  102.  
  103.  
  104.     if ( -e "$base.mwl.gz" ){
  105.         $unpack = "zcat $base.mwl.gz";
  106.     } elsif ( -e "$base.wl.gz") {
  107.         $unpack = "zcat $base.wl.gz";
  108.     } elsif ( -e "$base.cwl.gz") {
  109.         $unpack = "zcat $base.cwl.gz | precat";
  110.     } else {
  111.         mymessage "Could not find any of $base.{mwl,wl,cwl}.gz";
  112.         return 0;
  113.     }
  114.  
  115.     #$unpack = "$unpack | aspell clean strict";
  116.     system ("$unpack | aspell $options --local-data-dir=$data --lang=$lang create master $hash") == 0
  117.         or $msg = "Could not build the hash file for $sublang" ;
  118.  
  119.     if ( $msg ){             # Do not break postinst if hash cannot be built
  120.         mymessage ($msg);    # Just inform about that
  121.         return 0;
  122.     }
  123.     }
  124.     return 1;
  125. }
  126.  
  127. # ---------------------------------------------------------------------
  128. #                   Get aspell compat version
  129. # ---------------------------------------------------------------------
  130.  
  131. sub get_aspell_compat {
  132.  
  133.     my $aspell_compat = '';
  134.  
  135.     if ( -e $aspellcompatfile ){
  136.     open (COMPAT,"$aspellcompatfile");
  137.     chomp ( $aspell_compat = <COMPAT> );
  138.     close COMPAT;
  139.     } else {
  140.     $force = "yes";
  141.     }
  142.     return $aspell_compat;
  143. }
  144.  
  145. # ---------------------------------------------------------------------
  146. #                        The main program
  147. # ---------------------------------------------------------------------
  148.  
  149. use Debian::DictionariesCommon q(dico_checkroot);
  150. use Debconf::Client::ConfModule q(:all);
  151. use Getopt::Long;
  152.  
  153. dico_checkroot();
  154.  
  155. $compatdir        = "/var/lib/aspell";
  156. $aspellcompatfile = "/usr/share/aspell/aspell.compat";
  157.  
  158. $force        = '';
  159. $debug        = '';
  160.  
  161. GetOptions ('debug' => \$debug,
  162.         'force' => \$force) or usage();
  163.  
  164. if ( -x "/usr/bin/aspell" ){
  165.  
  166.     $aspell_compat = get_aspell_compat();
  167.  
  168.     foreach $compat ( <$compatdir/*.compat> ){
  169.     my $build_hash  = '';
  170.     my $lang_compat = '';
  171.  
  172.     $lang = $compat;
  173.     $lang =~ s/\.compat$//;
  174.     $lang =~ s/.*\///;
  175.  
  176.     open (COMPAT,"$compat");
  177.     $lang_compat = <COMPAT>;
  178.     close COMPAT;
  179.     $lang_compat = 0     if not $lang_compat;
  180.     chomp $lang_compat;
  181.  
  182.     $build_hash  = "yes" if ( $aspell_compat ne $lang_compat );
  183.     $build_hash  = "yes" if $force;
  184.  
  185.     if ( $build_hash ){
  186.         debugprint "$lang => aspell_compat: [$aspell_compat]; lang_compat: [$lang_compat]";
  187.         if ( autorebuild($lang) ){
  188.         debugprint " +++ Updating $compat";
  189.         open (COMPAT,">","$compat");
  190.         if ( $aspell_compat ){
  191.             print COMPAT "$aspell_compat\n";
  192.         } else {
  193.             print COMPAT "0\n";
  194.         }
  195.         close COMPAT;
  196.         } else {
  197.         debugprint " --- $compat not updated because of an error";
  198.         }
  199.     }
  200.     }
  201. } else {
  202.     debugprint " aspell is not installed. Doing nothing";
  203. }
  204.  
  205. __END__
  206.  
  207. =head1 NAME
  208.  
  209. B<aspell-autobuildhash> - Autobuilding aspell hash files for some dicts
  210.  
  211. =head1 SYNOPSIS
  212.  
  213.  aspell-autobuildhash [--force]
  214.  
  215.    Options:
  216.     --debug      Show extra info about aspell-autobuildhash internal
  217.                  work. Will also enable aspell affix validation.
  218.     --force      Rebuild the hash file for all dicts providing a
  219.                  compat file skipping the test.
  220.  
  221. =head1 DESCRIPTION
  222.  
  223. B<aspell-autobuildhash> is a script that will manage aspell hash files
  224. autobuild, intended to be called from the dictionaries-common tools.
  225. Depending on the aspell
  226. compatibility level and on the compatibility level used for the hash file
  227. if present, will decide whether it must be rebuilt or not. This script will
  228. only work on aspell packages prepared to use it, it will do nothing for other
  229. aspell dict packages.
  230.  
  231. =head1 OPTIONS
  232.  
  233.  --debug      Show some extra information about aspell-autobuildhash
  234.               internal work. Will also enable aspell affix validation.
  235.  --force      Rebuild the hash file for all dicts providing a compat
  236.               file regardless of the compatibility levels found.
  237.  
  238. =head1 PACKAGE MAINTAINERS
  239.  
  240. To use this system, just provide a F<$lang.compat> file in F</var/lib/aspell>
  241. (I<$lang> stands for the lang basename with variant if any, e.g. I<gl-minimos>
  242. or I<en>). Put a "0" in it or just create an empty one with touch.
  243.  
  244. Wordlists should previously be compressed either with gzip
  245. (and their extensions set as F<.mwl.gz> or F<.wl.gz>) or preferably
  246. first with aspell prezip and then gzipped (with F<.cwl.gz> extension).
  247. This applies both for plain wordlists and munched wordlists
  248. (in the ispell way) if you use affix compression.
  249.  
  250. If your package will provide a single hash, install prezipped+gzipped
  251. wordlist as F</usr/share/aspell/$lang.cwl.gz> or, if prezip is not used,
  252. as F</usr/share/aspell/$lang.mwl.gz>.
  253.  
  254. If your package will provide more than one aspell hash for the same $lang,
  255. you will need to place each compressed wordlist as e.g.
  256. F</usr/share/aspell/$subdict.cwl.gz>, and the common F<$lang.compat> as
  257. above. Then create a F</usr/share/aspell/$lang.contents> file with the
  258. base names of the subdicts, one in a line. For English that will contain,
  259. amongst other possible lines
  260.  
  261.  en-common
  262.  en-variant_0
  263.  en-variant_1
  264.  en-variant_2
  265.  en_CA-w_accents-only
  266.  
  267. No need to use this file if a single hash is being created.
  268.  
  269. Dictionaries-common scripts will call internally this script and create a
  270. single hash file at F</var/lib/ispell/$lang.rws>, or hash files at
  271. F</var/lib/ispell/$subdict.rws>. You must set a symlink to that
  272. files from F</usr/lib/aspell/$lang.rws> or
  273. F</usr/lib/aspell/$subdict.rws> as appropriate.
  274. You are also suggested to create empty files at
  275. F</var/lib/aspell/$lang.rws> or for all of the
  276. F</var/lib/aspell/$subdict.rws> in the install target of
  277. your package build process. This empty file will be overwritten when the
  278. real hash is created, but will make the hash be removed at package
  279. removal without any magic being done in the postrm and will also help to
  280. keep track about which package owns that file.
  281.  
  282. B<aspell> maintainer should also call this script from package postinst.
  283. When comparing versions it will get the aspell version from file
  284. F</usr/share/aspell/aspell.compat>.
  285.  
  286. =head1 AUTHORS
  287.  
  288. Agustin Martin <agmartin@debian.org>
  289.  
  290. =cut
  291.  
  292.